Skip to main content
Glama
hyperspell

hyperspell-mcp

Official
by hyperspell

Add File

Add files or websites from URLs to Hyperspell for connecting AI applications to unstructured and semi-structured data.

Instructions

Add a file or website from a URL to Hyperspell.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYes

Implementation Reference

  • The handler function `add_file` that executes the tool logic: adds a file or URL to Hyperspell via API and returns DocumentStatus.
    def add_file(url: str) -> DocumentStatus:
        """Add a file or URL to Hyperspell."""
        r = mcp.api.documents.add_url(url=url, collection=mcp.config.collection)
        return DocumentStatus.from_pydantic(r)
  • Registration of the "Add File" tool using the @mcp.tool decorator.
    @mcp.tool(
        name="Add File", description="Add a file or website from a URL to Hyperspell."
    )
  • Pydantic-compatible dataclass schema for the output type DocumentStatus used by the tool.
    class DocumentStatus(BaseModel):
        id: int
        status: str
        collection: str
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It states the action ('Add') but doesn't explain what 'Add' entails—e.g., whether it uploads, links, or imports, what permissions are needed, if it's idempotent, or what happens on failure. This leaves significant gaps for a mutation tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence with no wasted words. It's front-loaded with the core action and resource, making it easy to parse quickly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutation tool with no annotations, 0% schema coverage, and no output schema, the description is inadequate. It lacks details on behavior, error handling, return values, and how it differs from siblings, failing to provide a complete picture for safe and effective use.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 1 parameter with 0% description coverage, so the description must compensate. It mentions 'from a URL' which implies the 'url' parameter is for a web address, but doesn't specify format constraints, supported protocols, or size limits. This adds minimal value beyond the schema's basic type.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Add a file or website') and the target system ('to Hyperspell'), which is specific and unambiguous. However, it doesn't explicitly differentiate from sibling tools like 'Add Memory' or 'Search Hyperspell', which might have overlapping functionality for adding content.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites, exclusions, or compare it to sibling tools like 'Add Memory' or 'Search Hyperspell', leaving the agent to infer usage context.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/hyperspell/hyperspell-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server